Skip to content

Improve English grammar and clarity across all documentation and Python docstrings - #1249

Merged
wannaphong merged 8 commits into
devfrom
copilot/improve-english-in-docs
Jan 31, 2026
Merged

Improve English grammar and clarity across all documentation and Python docstrings#1249
wannaphong merged 8 commits into
devfrom
copilot/improve-english-in-docs

Conversation

Copilot AI commented Jan 31, 2026

Copy link
Copy Markdown
Contributor

What do these changes do

Systematically improved English language quality across 45+ files including documentation files (markdown, RST) and Python docstrings: grammar fixes, consistent terminology, clearer word choice, removed verbose phrasing, and updated outdated references.

What was wrong

Documentation and Python docstrings contained grammar errors (plural/singular mismatches, incorrect verb forms), inconsistent terminology (setup.py vs pyproject.toml), missing hyphens in compound adjectives, verbose phrasing ("This function" pattern), typos, and awkward phrasing that reduced clarity for non-native English speakers.

How this fixes it

Documentation files (15 files):

Grammar corrections:

  • Verb agreement: "who are using" → "who is using", "pledge to making" → "pledge to make"
  • Singular/plural: "codes" → "code", "dependency" → "dependencies"
  • Compound adjectives: "AI assisted" → "AI-assisted", "Commented out" → "Commented-out"

Consistency improvements:

  • Updated setup.py references → pyproject.toml (reflects current project structure)
  • Fixed step numbering in release.md (was 0,1,3,4... now 0,1,2,3...)
  • Standardized formal examples: "like" → "such as"

Clarity enhancements:

  • Removed redundant phrasing: "on both X and also Y" → "on both X and Y"
  • Fixed table formatting in corpus_license.md
  • Broke up overly long sentences in docs/notes/start.rst
  • Clarified obsolete status in tokenization-benchmark.md

Python docstrings (30+ files across core modules):

Removed verbose phrasing:

  • "This function converts..." → "Converts..."
  • "This function will detokenize..." → "Detokenizes..."
  • Applied to tokenize, spell, word_vector, wsd, transliterate, summarize, soundex, and util modules

Fixed grammar and typos:

  • "the word is that mostly unrelated" → "the word that is mostly unrelated"
  • "list of words are" → "list of words is"
  • "incurs an edit distance" → "have an edit distance"
  • "repiitition" → "repetition"
  • "fits" → "fit", "map" → "maps", "stopword" → "stopwords"

Improved clarity:

  • "This function will call reorder_vowels() first, to make sure that..." → "Calls reorder_vowels() first to ensure that..."
  • Standardized article usage and verb forms throughout
  • Enhanced professional tone across all docstrings

Your checklist for this pull request

  • Passed code styles and structures
  • Passed code linting checks and unit test
Original prompt

Improve English in all docs


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 3 commits January 31, 2026 05:30
Co-authored-by: wannaphong <8536487+wannaphong@users.noreply.github.com>
Co-authored-by: wannaphong <8536487+wannaphong@users.noreply.github.com>
Co-authored-by: wannaphong <8536487+wannaphong@users.noreply.github.com>
@wannaphong

Copy link
Copy Markdown
Member

@copilot Imrpove English in docstring (all python)

Copilot AI changed the title [WIP] Update all documentation for improved English Improve English grammar and clarity across all documentation Jan 31, 2026
Copilot AI requested a review from wannaphong January 31, 2026 05:36
Copilot AI and others added 2 commits January 31, 2026 05:41
Co-authored-by: wannaphong <8536487+wannaphong@users.noreply.github.com>
Co-authored-by: wannaphong <8536487+wannaphong@users.noreply.github.com>

Copilot AI commented Jan 31, 2026

Copy link
Copy Markdown
Contributor Author

@copilot Imrpove English in docstring (all python)

I've systematically improved English in Python docstrings across the codebase. Fixed over 40 files so far with changes including:

  • Removed verbose "This function" phrasing → direct verbs
  • Fixed grammar issues ("list of words are" → "is", "incurs" → "have", "fits" → "fit")
  • Corrected typos ("repiitition" → "repetition")
  • Improved clarity and consistency throughout

Commits:

  • 8eba884 - Batch 1: Core modules (tokenize, spell, word_vector, wsd, util)
  • f81b2c2 - Batch 2: soundex, transliterate, more util modules

Continuing with remaining files...

…ize)

Co-authored-by: wannaphong <8536487+wannaphong@users.noreply.github.com>
Copilot AI changed the title Improve English grammar and clarity across all documentation Improve English grammar and clarity across all documentation and Python docstrings Jan 31, 2026
@wannaphong
wannaphong marked this pull request as ready for review January 31, 2026 05:49
@wannaphong
wannaphong requested a review from bact January 31, 2026 07:14
@bact bact added the documentation improve documentation and test cases label Jan 31, 2026
@bact bact added this to the 5.3 milestone Jan 31, 2026
@sonarqubecloud

Copy link
Copy Markdown

@wannaphong
wannaphong merged commit 19aab39 into dev Jan 31, 2026
32 checks passed
@wannaphong
wannaphong deleted the copilot/improve-english-in-docs branch January 31, 2026 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation improve documentation and test cases

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants